home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 2 / Atari Mega Archive CD - Volume 2.iso / minix / up1510b.tgz / up1510b / doc / rz.doc < prev    next >
Text File  |  1990-07-19  |  11KB  |  332 lines
  1.  
  2.  
  3.  
  4.      RZ(1)                                                RZ(1)
  5.  
  6.  
  7.  
  8.      NAME
  9.           rx, rb, rz - XMODEM, YMODEM, ZMODEM (Batch) file receive
  10.  
  11.      SYNOPSIS
  12.           rz [- +abepqtuvy]
  13.           rb [- +abqtuvy]
  14.           rx [- abceqtuv] file
  15.           gz file ...
  16.           [-][v]rzCOMMAND
  17.  
  18.      DESCRIPTION
  19.           This program uses error correcting protocols to receive
  20.           files over a dial-in serial port from a variety of programs
  21.           running under PC-DOS, CP/M, Unix, and other operating
  22.           systems.  It is invoked from a shell prompt manually, or
  23.           automatically as a result of an "sz file ..." command given
  24.           to the calling program.
  25.  
  26.           While rz is smart enough to be called from cu(1), very few
  27.           versions of cu(1) are smart enough to allow rz to work
  28.           properly.  Unix flavors of Professional-YAM are available
  29.           for such dial-out application.
  30.  
  31.  
  32.           Rz (Receive ZMODEM) receives files with the ZMODEM batch
  33.           protocol.  Pathnames are supplied by the sending program,
  34.           and directories are made if necessary (and possible).
  35.           Normally, the "rz" command is automatically issued by the
  36.           calling ZMODEM program, but some defective ZMODEM
  37.           implementations may require starting rz the old fashioned
  38.           way.
  39.  
  40.  
  41.           Rb receives file(s) with YMODEM, accepting either standard
  42.           128 byte sectors or 1024 byte sectors (YAM sb -k option).
  43.           The user should determine when the 1024 byte block length
  44.           actually improves throughput without causing lost data or
  45.           even system crashes.
  46.  
  47.           If True YMODEM (Omen Technology trademark) file information
  48.           (file length, etc.)  is received, the file length controls
  49.           the number of bytes written to the output dataset, and the
  50.           modify time and file mode (iff non zero) are set
  51.           accordingly.
  52.  
  53.           If no True YMODEM file information is received, slashes in
  54.           the pathname are changed to underscore, and any trailing
  55.           period in the pathname is eliminated.  This conversion is
  56.           useful for files received from CP/M systems.  With YMODEM,
  57.           each file name is converted to lower case unless it contains
  58.           one or more lower case letters.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/18/89)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      RZ(1)                                                RZ(1)
  71.  
  72.  
  73.  
  74.           Rx receives a single file with XMODEM or XMODEM-1k protocol.
  75.           The user should determine when the 1024 byte block length
  76.           actually improves throughput without causing problems.  The
  77.           user must supply the file name to both sending and receiving
  78.           programs.  Up to 1023 garbage characters may be added to the
  79.           received file.
  80.  
  81.           Gz is a shell script which calls sz to command Pro-YAM or
  82.           ZCOMM to transmit the specified files.  Pathnames used with
  83.           gz must be escaped if they have special significance to the
  84.           Unix shell.
  85.           EXAMPLE:  gz "-a C:*.c D:*.h"
  86.  
  87.  
  88.           Rz may be invoked as rzCOMMAND (with an optional leading -
  89.           as generated by login(1)).  For each received file, rz will
  90.           pipe the file to ``COMMAND filename'' where filename is the
  91.           name of the transmitted file with the file contents as
  92.           standard input.
  93.  
  94.           Each file transfer is acknowledged when COMMAND exits with 0
  95.           status.  A non zero exit status terminates transfers.
  96.  
  97.           A typical use for this form is rzrmail which calls rmail(1)
  98.           to post mail to the user specified by the transmitted file
  99.           name.  For example, sending the file "caf" from a PC-DOS
  100.           system to rzrmail on a Unix system would result in the
  101.           contents of the DOS file "caf" being mailed to user "caf".
  102.  
  103.           On some Unix systems, the login directory must contain a
  104.           link to COMMAND as login sets SHELL=rsh which disallows
  105.           absolute pathnames.  If invoked with a leading ``v'', rz
  106.           will report progress to /tmp/rzlog.  The following entry
  107.           works for Unix SYS III/V:
  108.                      rzrmail::5:1::/bin:/usr/local/rzrmail
  109.           If the SHELL environment variable includes rsh or rksh
  110.           (restricted shell), rz will not accept absolute pathnames or
  111.           references to a parent directory, will not modify an
  112.           existing file, and removes any files received in error.
  113.  
  114.           If rz is invoked with stdout and stderr to different
  115.           datasets, Verbose is set to 2, causing frame by frame
  116.           progress reports to stderr.  This may be disabled with the q
  117.           option.
  118.  
  119.  
  120.           The meanings of the available options are:
  121.  
  122.           a    Convert files to Unix conventions by stripping carriage
  123.                returns and all characters beginning with the first
  124.                Control Z (CP/M end of file).
  125.           b    Binary (tell it like it is) file transfer override.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/18/89)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      RZ(1)                                                RZ(1)
  137.  
  138.  
  139.  
  140.           c    Request 16 bit CRC.  XMODEM file transfers default to 8
  141.                bit checksum.  YMODEM and ZMODEM normally use 16 bit
  142.                CRC.
  143.           D    Output file data to /dev/null; for testing.  (Unix
  144.                only)
  145.           e    Force sender to escape all control characters; normally
  146.                XON, XOFF, DLE, CR-@-CR, and Ctrl-X are escaped.
  147.           p    (ZMODEM) Protect: skip file if destination file exists.
  148.           q    Quiet suppresses verbosity.
  149.           t tim
  150.                Change timeout to tim tenths of seconds.
  151.           v    Verbose causes a list of file names to be appended to
  152.                /tmp/rzlog .  More v's generate more output.
  153.           y    Yes, clobber any existing files with the same name.
  154.  
  155.      EXAMPLES
  156.           (Pro-YAM command)
  157.           <ALT-2>
  158.           Pro-YAM Command:  sz *.h *.c
  159.           (This automatically invokes rz on the connected system.)
  160.  
  161.      SEE ALSO
  162.           ZMODEM.DOC, YMODEM.DOC, Professional-YAM, crc(omen),
  163.           sz(omen), usq(omen), undos(omen)
  164.  
  165.           Compile time options required for various operating systems
  166.           are described in the source file.
  167.  
  168.      NOTES
  169.           Sending serial data to timesharing minicomputers at
  170.           sustained high speeds has been known to cause lockups,
  171.           system halts, kernel panics, and occasional antisocial
  172.           behaviour.  When experimenting with high speed input to a
  173.           system, consider rebooting the system if the file transfers
  174.           are not successful, especially if the personality of the
  175.           system appears altered.
  176.  
  177.           The Unix "ulimit" parameter must be set high enough to
  178.           permit large file transfers.
  179.  
  180.           The TTY input buffering on some systems may not allow long
  181.           blocks or streaming input at high speed.  You should suspect
  182.           this problem when you can't send data to the Unix system at
  183.           high speeds using ZMODEM, YMODEM-1k or XMODEM-1k, when
  184.           YMODEM with 128 byte blocks works properly.  If the system's
  185.           tty line handling is really broken, the serial port or the
  186.           entire system may not survive the onslaught of long bursts
  187.           of high speed data.
  188.  
  189.           The DSZ or Pro-YAM zmodem l numeric parameter may be set to
  190.           a value between 64 and 1024 to limit the burst length
  191.           ("zmodem pl128").
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/18/89)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      RZ(1)                                                RZ(1)
  203.  
  204.  
  205.  
  206.           32 bit CRC code courtesy Gary S. Brown.  Directory creation
  207.           code from John Gilmore's PD TAR program.
  208.  
  209.      BUGS
  210.           Calling rz from most versions of cu(1) doesn't work because
  211.           cu's receive process fights rz for characters from the
  212.           modem.
  213.  
  214.           Programs that do not properly implement the specified file
  215.           transfer protocol may cause sz to "hang" the port for a
  216.           minute or two.  Every reported instance of this pro